/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Esta Anotação é utilizada em campo que devem ser manipuladores de uma
 * seleção de entidades.<br>
 * Quando se utilizada uma definição como <code>FieldSelection</code> ou
 * <code>CriteriaSelection</code> ou <code>ColumnSelection</code>, na entidade
 * associada deve ser definida qual o(s) campo(s) que deve ser utilizado
 * para selecionar a entidade, podendo ser o campo ID ou outro qualquer ou
 * ainda a combinação de vários campos.
 *
 * @author Glauco
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Selection {

    /**
     * Alias para o campo ser utilizado em seleção em paineis.
     * @return
     */
    public String[] aliasForFields() default {};

    /**
     * Alias para o campo ser utilizado em seleção em grids.
     * @return
     */
    public String[] aliasForColuns() default {};

    /**
     * Alias para o campo ser utilizado em seleção em Filtros.
     * @return
     */
    public String[] aliasForCriteria() default {};

    /**
     * Tipo de filtro que será utilizado para seleção.<br>
     * Apesar dos vários tipos só será aceito <code>EQUALS</code> ou
     * <code>ILIKE</code>.<br>
     * Outros tipos de filtros não serão considerados e o padrão será o
     * <code>ILIKE</code>.
     *
     * @return
     */
    public FilterType filterType();
}
